svelte-common

svelte-common

common components utils used in svelte apps

usage

Check out the code in the example folder, or the live example.

API

Table of Contents

• AttributeDefinition
  • Properties
• tokens
  • Parameters
• setAttribute
  • Parameters
• getAttribute
  • Parameters
• getAttributeAndOperator
  • Parameters
• filter
  • Parameters
• initializeServiceWorker
  • Parameters
• toggleOrderBy
  • Parameters
• sortable
  • Parameters
• sorter
  • Parameters
• keyPrefixStore
  • Parameters

AttributeDefinition

Type: Object

Properties

• type string
• writable boolean
• private boolean? should the value be shown
• depends string? name of an attribute we depend on
• additionalAttributes Array<string> extra attributes that are present in case our attribute is set
• description string
• default any? the default value
• set Function? set the value
• get Function? get the value can be used to calculate default values
• env (Array<string> | string)? environment variable use to provide the value

tokens

Split property path into tokens

Parameters

• string string

setAttribute

Set Object attribute. The name may be a property path like 'a.b.c'.

Parameters

• object Object
• name string
• value any

getAttribute

Deliver attribute value. The name may be a property path like 'a.b.c'.

Parameters

• object Object
• name string

Returns any value associated with the given property name

getAttributeAndOperator

Deliver attribute value and operator. The name may be a property path like 'a.b.c <='.

Parameters

• object Object
• expression string
• getters (optional, default {})

Returns [any, string] value associated with the given property name

filter

Generate filter function.

Parameters

• filterBy Object?
• getters Object?

Returns Function

initializeServiceWorker

Create a store holding a service worker

Parameters

• script string The URL of the service worker script
• options Object An object containing registration options

Returns Object store holding the service worker

toggleOrderBy

Deliver next value in the order by cycle. SORT_NONE -> SORT_ASCENDING -> SORT_DESCENDING -> SORT_NONE ...

Parameters

• orderBy string

Returns string new order either SORT_NONE, SORT_ASCENDING or SORT_DESCENDING

sortable

Add sortable toggle button to a th node. Synchronizes store value with the nodes "aria-sort" attribute.

Parameters

• th Element the header node
• store WritableStore keep in sync with sorting properties

sorter

Generate a sort function for a given sort-by set.

Parameters

• sortBy (Object | undefined)?
• getters Object?

Returns (Function | undefined) sorter

keyPrefixStore

Create a derived store where all the object keys are prefixed.

{ a: 1, b: 2 } -> { foo_a: 1 foo_b: 2 } // prefix: foo_

Parameters

• store WriteableStore we derive from
• prefix string for each key

Returns WriteableStore

install

With npm do:

npm install svelte-common

or with yarn

yarn add svelte-common

license

BSD-2-Clause